API for configuring and manipulating Fingerprint 5 Click driver. More...

Topics
	Fingerprint 5 Device Settings
	Settings for registers of Fingerprint 5 Click driver.
	Fingerprint 5 MikroBUS Map
	MikroBUS pin mapping of Fingerprint 5 Click driver.

Functions
void	fingerprint5_cfg_setup (fingerprint5_cfg_t *cfg)
	Fingerprint 5 configuration object setup function.
err_t	fingerprint5_init (fingerprint5_t ctx, fingerprint5_cfg_t cfg)
	Fingerprint 5 initialization function.
void	fingerprint5_drv_interface_sel (fingerprint5_cfg_t *cfg, fingerprint5_drv_t drv_sel)
	Fingerprint 5 driver interface setup function.
err_t	fingerprint5_generic_write (fingerprint5_t ctx, uint8_t data_in, uint16_t len)
	Fingerprint 5 write data function.
err_t	fingerprint5_generic_read (fingerprint5_t ctx, uint8_t data_out, uint16_t len)
	Fingerprint 5 read data function.
void	fingerprint5_set_rst_pin (fingerprint5_t *ctx, uint8_t state)
	Fingerprint 5 set RST pin function.
void	fingerprint5_reset_device (fingerprint5_t *ctx)
	Fingerprint 5 hardware reset function.
uint8_t	fingerprint5_get_irq_pin (fingerprint5_t *ctx)
	Fingerprint 5 get IRQ pin function.
err_t	fingerprint5_send_cmd (fingerprint5_t *ctx)
	Fingerprint 5 send command function.
err_t	fingerprint5_read_cmd (fingerprint5_t *ctx)
	Fingerprint 5 read command function.
err_t	fingerprint5_get_status (fingerprint5_t *ctx)
	Fingerprint 5 get status function.
err_t	fingerprint5_get_version (fingerprint5_t *ctx)
	Fingerprint 5 get version function.
err_t	fingerprint5_enroll_finger (fingerprint5_t *ctx)
	Fingerprint 5 enroll finger function.
err_t	fingerprint5_identify_finger (fingerprint5_t *ctx)
	Fingerprint 5 identify finger function.
err_t	fingerprint5_request_abort (fingerprint5_t *ctx)
	Fingerprint 5 request abort function.
err_t	fingerprint5_list_templates (fingerprint5_t *ctx)
	Fingerprint 5 list templates function.
err_t	fingerprint5_delete_templates (fingerprint5_t *ctx)
	Fingerprint 5 delete templates function.
err_t	fingerprint5_request_reset (fingerprint5_t *ctx)
	Fingerprint 5 request reset function.
err_t	fingerprint5_start_navigation (fingerprint5_t *ctx, uint8_t orientation)
	Fingerprint 5 start navigation function.
err_t	fingerprint5_run_bist (fingerprint5_t *ctx)
	Fingerprint 5 run BIST function.
err_t	fingerprint5_set_gpio (fingerprint5_t *ctx, uint8_t pin, uint8_t mode, uint8_t state)
	Fingerprint 5 set GPIO function.
err_t	fingerprint5_get_gpio (fingerprint5_t *ctx, uint8_t pin)
	Fingerprint 5 get GPIO function.
err_t	fingerprint5_set_config (fingerprint5_t ctx, fingerprint5_sys_config_t config)
	Fingerprint 5 set system config function.
err_t	fingerprint5_get_config (fingerprint5_t *ctx, uint8_t type)
	Fingerprint 5 get system config function.

Detailed Description

API for configuring and manipulating Fingerprint 5 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ fingerprint5_cfg_setup()

void fingerprint5_cfg_setup ( fingerprint5_cfg_t * cfg )

Fingerprint 5 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See fingerprint5_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ fingerprint5_delete_templates()

err_t fingerprint5_delete_templates ( fingerprint5_t * ctx )

Fingerprint 5 delete templates function.

This function sends the delete command to remove all stored fingerprint templates.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_drv_interface_sel()

void fingerprint5_drv_interface_sel	(	fingerprint5_cfg_t *	cfg,
		fingerprint5_drv_t	drv_sel )

Fingerprint 5 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See fingerprint5_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See fingerprint5_drv_t object definition for detailed explanation.

Returns: Nothing.

Note: This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ fingerprint5_enroll_finger()

err_t fingerprint5_enroll_finger ( fingerprint5_t * ctx )

Fingerprint 5 enroll finger function.

This function sends the enroll command for fingerprint registration.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_generic_read()

err_t fingerprint5_generic_read	(	fingerprint5_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

Fingerprint 5 read data function.

This function reads a desired number of data bytes from the selected interface.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[out]	data_out	: Output data buffer.
[in]	len	: Number of bytes to read.

Returns

0 - Success,
-1 - Error,
-2 - Timeout error.

Note: None.

◆ fingerprint5_generic_write()

err_t fingerprint5_generic_write	(	fingerprint5_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

Fingerprint 5 write data function.

This function writes a desired number of data bytes to the selected interface.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	data_in	: Data buffer to be written.
[in]	len	: Number of bytes to write.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_get_config()

err_t fingerprint5_get_config	(	fingerprint5_t *	ctx,
		uint8_t	type )

Fingerprint 5 get system config function.

This function sends the get system configuration command for the specified configuration type.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	type	: System configuration type.

Returns

0 - Success,
-1 - Error (invalid parameter).

Note: None.

◆ fingerprint5_get_gpio()

err_t fingerprint5_get_gpio	(	fingerprint5_t *	ctx,
		uint8_t	pin )

Fingerprint 5 get GPIO function.

This function sends the GPIO get command to read the state of a GPIO pin.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	pin	: GPIO pin number.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_get_irq_pin()

uint8_t fingerprint5_get_irq_pin ( fingerprint5_t * ctx )

Fingerprint 5 get IRQ pin function.

This function returns the state of the IRQ (interrupt) pin.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ fingerprint5_get_status()

err_t fingerprint5_get_status ( fingerprint5_t * ctx )

Fingerprint 5 get status function.

This function sends the status request command to the device.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_get_version()

err_t fingerprint5_get_version ( fingerprint5_t * ctx )

Fingerprint 5 get version function.

This function sends the firmware version request command to the device.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_identify_finger()

err_t fingerprint5_identify_finger ( fingerprint5_t * ctx )

Fingerprint 5 identify finger function.

This function sends the identify command to compare the input fingerprint with existing templates.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_init()

err_t fingerprint5_init	(	fingerprint5_t *	ctx,
		fingerprint5_cfg_t *	cfg )

Fingerprint 5 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See fingerprint5_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ fingerprint5_list_templates()

err_t fingerprint5_list_templates ( fingerprint5_t * ctx )

Fingerprint 5 list templates function.

This function sends the list templates command to retrieve all stored fingerprint templates.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_read_cmd()

err_t fingerprint5_read_cmd ( fingerprint5_t * ctx )

Fingerprint 5 read command function.

This function reads a response or event frame from the device.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error,
-2 - Timeout error.

Note: None.

◆ fingerprint5_request_abort()

err_t fingerprint5_request_abort ( fingerprint5_t * ctx )

Fingerprint 5 request abort function.

This function sends the abort command to stop the current fingerprint operation.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_request_reset()

err_t fingerprint5_request_reset ( fingerprint5_t * ctx )

Fingerprint 5 request reset function.

This function sends the reset command to restart the fingerprint sensor firmware.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_reset_device()

void fingerprint5_reset_device ( fingerprint5_t * ctx )

Fingerprint 5 hardware reset function.

This function performs a hardware reset by toggling the RST pin.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ fingerprint5_run_bist()

err_t fingerprint5_run_bist ( fingerprint5_t * ctx )

Fingerprint 5 run BIST function.

This function sends the built-in self-test command to initiate internal diagnostics.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_send_cmd()

err_t fingerprint5_send_cmd ( fingerprint5_t * ctx )

Fingerprint 5 send command function.

This function sends a prepared command frame to the device.

Parameters

[in] ctx : Click context object. See fingerprint5_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ fingerprint5_set_config()

err_t fingerprint5_set_config	(	fingerprint5_t *	ctx,
		fingerprint5_sys_config_t *	config )

Fingerprint 5 set system config function.

This function sends the set system configuration command with the specified configuration values.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	config	: System configuration parameters.

Returns

0 - Success,
-1 - Error (null pointer or communication error).

Note: None.

◆ fingerprint5_set_gpio()

err_t fingerprint5_set_gpio	(	fingerprint5_t *	ctx,
		uint8_t	pin,
		uint8_t	mode,
		uint8_t	state )

Fingerprint 5 set GPIO function.

This function sends the GPIO set command to configure a GPIO pin state and mode.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	pin	: GPIO pin number.
[in]	mode	: GPIO mode.
[in]	state	: GPIO logic state.

Returns

0 - Success,
-1 - Error (invalid parameter).

Note: None.

◆ fingerprint5_set_rst_pin()

void fingerprint5_set_rst_pin	(	fingerprint5_t *	ctx,
		uint8_t	state )

Fingerprint 5 set RST pin function.

This function sets the RST (reset) pin logic state.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	state	: Pin state (0 or 1).

Returns: None.

Note: None.

◆ fingerprint5_start_navigation()

err_t fingerprint5_start_navigation	(	fingerprint5_t *	ctx,
		uint8_t	orientation )

Fingerprint 5 start navigation function.

This function starts the navigation feature based on the specified screen orientation.

Parameters

[in]	ctx	: Click context object. See fingerprint5_t object definition for detailed explanation.
[in]	orientation	: Navigation screen orientation [0-3].

Returns

0 - Success,
-1 - Error (invalid parameter).

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ fingerprint5_cfg_setup()

◆ fingerprint5_delete_templates()

◆ fingerprint5_drv_interface_sel()

◆ fingerprint5_enroll_finger()

◆ fingerprint5_generic_read()

◆ fingerprint5_generic_write()

◆ fingerprint5_get_config()

◆ fingerprint5_get_gpio()

◆ fingerprint5_get_irq_pin()

◆ fingerprint5_get_status()

◆ fingerprint5_get_version()

◆ fingerprint5_identify_finger()

◆ fingerprint5_init()

◆ fingerprint5_list_templates()

◆ fingerprint5_read_cmd()

◆ fingerprint5_request_abort()

◆ fingerprint5_request_reset()

◆ fingerprint5_reset_device()

◆ fingerprint5_run_bist()

◆ fingerprint5_send_cmd()

◆ fingerprint5_set_config()

◆ fingerprint5_set_gpio()

◆ fingerprint5_set_rst_pin()

◆ fingerprint5_start_navigation()